+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-GtkButton
-
-<!-- ##### SECTION Short_Description ##### -->
-A widget that creates a signal when clicked on
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The #GtkButton widget is generally used to attach a function to that
-is called when the button is pressed. The various signals and how to use
-them are outlined below.
-</para>
-<para>
-The #GtkButton widget can hold any valid child widget. That is it can
-hold most any other standard #GtkWidget. The most commonly used child is
-the #GtkLabel.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkButton ##### -->
-<para>
-This should not be accessed directly. Use the accessor functions below.
-</para>
-
-
-<!-- ##### SIGNAL GtkButton::activate ##### -->
-<para>
-
-</para>
-
-@button: the object which received the signal.
-
-<!-- ##### SIGNAL GtkButton::clicked ##### -->
-<para>
-
-</para>
-
-@button:
-
-<!-- ##### SIGNAL GtkButton::enter ##### -->
-<para>
-
-</para>
-
-@button:
-
-<!-- ##### SIGNAL GtkButton::leave ##### -->
-<para>
-
-</para>
-
-@button:
-
-<!-- ##### SIGNAL GtkButton::pressed ##### -->
-<para>
-
-</para>
-
-@button:
-
-<!-- ##### SIGNAL GtkButton::released ##### -->
-<para>
-
-</para>
-
-@button:
-
-<!-- ##### ARG GtkButton:focus-on-click ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:image ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:image-position ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:label ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:relief ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:use-stock ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:use-underline ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:xalign ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:yalign ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:child-displacement-x ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:child-displacement-y ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:default-border ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:default-outside-border ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:displace-focus ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:image-spacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButton:inner-border ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_button_new ##### -->
-<para>
-Creates a new #GtkButton widget. To add a child widget to the button,
-use gtk_container_add().
-</para>
-
-@void:
-@Returns: The newly created #GtkButton widget.
-
-
-<!-- ##### FUNCTION gtk_button_new_with_label ##### -->
-<para>
-Creates a #GtkButton widget with a #GtkLabel child containing the given
-text.
-</para>
-
-@label: The text you want the #GtkLabel to hold.
-@Returns: The newly created #GtkButton widget.
-
-
-<!-- ##### FUNCTION gtk_button_new_with_mnemonic ##### -->
-<para>
-
-</para>
-
-@label:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_new_from_stock ##### -->
-<para>
-
-</para>
-
-@stock_id:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_pressed ##### -->
-<para>
-Emits a #GtkButton::pressed signal to the given #GtkButton.
-</para>
-
-@button: The #GtkButton you want to send the signal to.
-@Deprecated: 2.20: Use the #GtkWidget::button-press-event signal.
-
-
-<!-- ##### FUNCTION gtk_button_released ##### -->
-<para>
-Emits a #GtkButton::released signal to the given #GtkButton.
-</para>
-
-@button: The #GtkButton you want to send the signal to.
-@Deprecated: 2.20: Use the #GtkWidget::button-release-event signal.
-
-
-<!-- ##### FUNCTION gtk_button_clicked ##### -->
-<para>
-Emits a #GtkButton::clicked signal to the given #GtkButton.
-</para>
-
-@button: The #GtkButton you want to send the signal to.
-
-
-<!-- ##### FUNCTION gtk_button_enter ##### -->
-<para>
-Emits a #GtkButton::enter signal to the given #GtkButton.
-</para>
-
-@button: The #GtkButton you want to send the signal to.
-@Deprecated: 2.20: Use the #GtkWidget::enter-notify-event signal.
-
-
-<!-- ##### FUNCTION gtk_button_leave ##### -->
-<para>
-Emits a #GtkButton::leave signal to the given #GtkButton.
-</para>
-
-@button: The #GtkButton you want to send the signal to.
-@Deprecated: 2.20: Use the #GtkWidget::leave-notify-event signal.
-
-
-<!-- ##### FUNCTION gtk_button_set_relief ##### -->
-<para>
-Sets the relief style of the edges of the given #GtkButton widget.
-Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.
-The default style is, as one can guess, GTK_RELIEF_NORMAL.
-
-<!-- FIXME: put pictures of each style -->
-</para>
-
-@button: The #GtkButton you want to set relief styles of.
-@newstyle: The GtkReliefStyle as described above.
-
-
-<!-- ##### FUNCTION gtk_button_get_relief ##### -->
-<para>
-Returns the current relief style of the given #GtkButton.
-</para>
-
-@button: The #GtkButton you want the #GtkReliefStyle from.
-@Returns: The current #GtkReliefStyle
-
-
-<!-- ##### FUNCTION gtk_button_get_label ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_set_label ##### -->
-<para>
-
-</para>
-
-@button:
-@label:
-
-
-<!-- ##### FUNCTION gtk_button_get_use_stock ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_set_use_stock ##### -->
-<para>
-
-</para>
-
-@button:
-@use_stock:
-
-
-<!-- ##### FUNCTION gtk_button_get_use_underline ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_set_use_underline ##### -->
-<para>
-
-</para>
-
-@button:
-@use_underline:
-
-
-<!-- ##### FUNCTION gtk_button_set_focus_on_click ##### -->
-<para>
-
-</para>
-
-@button:
-@focus_on_click:
-
-
-<!-- ##### FUNCTION gtk_button_get_focus_on_click ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_set_alignment ##### -->
-<para>
-
-</para>
-
-@button:
-@xalign:
-@yalign:
-
-
-<!-- ##### FUNCTION gtk_button_get_alignment ##### -->
-<para>
-
-</para>
-
-@button:
-@xalign:
-@yalign:
-
-
-<!-- ##### FUNCTION gtk_button_set_image ##### -->
-<para>
-
-</para>
-
-@button:
-@image:
-
-
-<!-- ##### FUNCTION gtk_button_get_image ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_set_image_position ##### -->
-<para>
-
-</para>
-
-@button:
-@position:
-
-
-<!-- ##### FUNCTION gtk_button_get_image_position ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_button_get_event_window ##### -->
-<para>
-
-</para>
-
-@button:
-@Returns:
-
-
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+/**
+ * SECTION:gtkbutton
+ * @Short_description: A widget that creates a signal when clicked on
+ * @Title: GtkButton
+ *
+ * The #GtkButton widget is generally used to attach a function to that is
+ * called when the button is pressed. The various signals and how to use them
+ * are outlined below.
+ *
+ * The #GtkButton widget can hold any valid child widget. That is it can hold
+ * most any other standard #GtkWidget. The most commonly used child is the
+ * #GtkLabel.
+ */
+
#include "config.h"
#include <string.h>
#include "gtkalignment.h"
* If the child of the button is a #GtkMisc or #GtkAlignment, this property
* can be used to control it's horizontal alignment. 0.0 is left aligned,
* 1.0 is right aligned.
- *
+ *
* Since: 2.4
*/
g_object_class_install_property (gobject_class,
* If the child of the button is a #GtkMisc or #GtkAlignment, this property
* can be used to control it's vertical alignment. 0.0 is top aligned,
* 1.0 is bottom aligned.
- *
+ *
* Since: 2.4
*/
g_object_class_install_property (gobject_class,
/**
* GtkButton::image:
- *
+ *
* The child widget to appear next to the button text.
- *
+ *
* Since: 2.6
*/
g_object_class_install_property (gobject_class,
* GtkButton:image-position:
*
* The position of the image relative to the text inside the button.
- *
+ *
* Since: 2.10
*/
g_object_class_install_property (gobject_class,
* @button: the object that received the signal
*
* Emitted when the button is pressed.
- *
+ *
* Deprecated: 2.8: Use the #GtkWidget::button-press-event signal.
*/
button_signals[PRESSED] =
* @button: the object that received the signal
*
* Emitted when the button is released.
- *
+ *
* Deprecated: 2.8: Use the #GtkWidget::button-release-event signal.
*/
button_signals[RELEASED] =
* @button: the object that received the signal
*
* Emitted when the pointer enters the button.
- *
+ *
* Deprecated: 2.8: Use the #GtkWidget::enter-notify-event signal.
*/
button_signals[ENTER] =
* @button: the object that received the signal
*
* Emitted when the pointer leaves the button.
- *
+ *
* Deprecated: 2.8: Use the #GtkWidget::leave-notify-event signal.
*/
button_signals[LEAVE] =
/**
* GtkButton::image-spacing:
- *
+ *
* Spacing in pixels between the image and label.
- *
+ *
* Since: 2.10
*/
gtk_widget_class_install_style_property (widget_class,
}
}
+/**
+ * gtk_button_new:
+ *
+ * Creates a new #GtkButton widget. To add a child widget to the button,
+ * use gtk_container_add().
+ *
+ * Returns: The newly created #GtkButton widget.
+ */
GtkWidget*
gtk_button_new (void)
{
}
+/**
+ * gtk_button_new_with_label:
+ * @label: The text you want the #GtkLabel to hold.
+ *
+ * Creates a #GtkButton widget with a #GtkLabel child containing the given
+ * text.
+ *
+ * Returns: The newly created #GtkButton widget.
+ */
GtkWidget*
gtk_button_new_with_label (const gchar *label)
{
return g_object_new (GTK_TYPE_BUTTON, "label", label, "use-underline", TRUE, NULL);
}
+/**
+ * gtk_button_pressed:
+ * @button: The #GtkButton you want to send the signal to.
+ *
+ * Emits a #GtkButton::pressed signal to the given #GtkButton.
+ *
+ * Deprecated: 2.20: Use the #GtkWidget::button-press-event signal.
+ */
void
gtk_button_pressed (GtkButton *button)
{
g_signal_emit (button, button_signals[PRESSED], 0);
}
+/**
+ * gtk_button_released:
+ * @button: The #GtkButton you want to send the signal to.
+ *
+ * Emits a #GtkButton::released signal to the given #GtkButton.
+ *
+ * Deprecated: 2.20: Use the #GtkWidget::button-release-event signal.
+ */
void
gtk_button_released (GtkButton *button)
{
g_signal_emit (button, button_signals[RELEASED], 0);
}
+/**
+ * gtk_button_clicked:
+ * @button: The #GtkButton you want to send the signal to.
+ *
+ * Emits a #GtkButton::clicked signal to the given #GtkButton.
+ */
void
gtk_button_clicked (GtkButton *button)
{
g_signal_emit (button, button_signals[CLICKED], 0);
}
+/**
+ * gtk_button_enter:
+ * @button: The #GtkButton you want to send the signal to.
+ *
+ * Emits a #GtkButton::enter signal to the given #GtkButton.
+ *
+ * Deprecated: 2.20: Use the #GtkWidget::enter-notify-event signal.
+ */
void
gtk_button_enter (GtkButton *button)
{
g_signal_emit (button, button_signals[ENTER], 0);
}
+/**
+ * gtk_button_leave:
+ * @button: The #GtkButton you want to send the signal to.
+ *
+ * Emits a #GtkButton::leave signal to the given #GtkButton.
+ *
+ * Deprecated: 2.20: Use the #GtkWidget::leave-notify-event signal.
+ */
void
gtk_button_leave (GtkButton *button)
{
g_signal_emit (button, button_signals[LEAVE], 0);
}
+/**
+ * gtk_button_set_relief:
+ * @button: The #GtkButton you want to set relief styles of.
+ * @newstyle: The GtkReliefStyle as described above.
+ *
+ * Sets the relief style of the edges of the given #GtkButton widget.
+ * Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.
+ * The default style is, as one can guess, GTK_RELIEF_NORMAL.
+ *
+ * <!-- FIXME: put pictures of each style -->
+ */
void
gtk_button_set_relief (GtkButton *button,
GtkReliefStyle newrelief)
}
}
+/**
+ * gtk_button_get_relief:
+ * @button: The #GtkButton you want the #GtkReliefStyle from.
+ *
+ * Returns the current relief style of the given #GtkButton.
+ *
+ * Returns: The current #GtkReliefStyle
+ */
GtkReliefStyle
gtk_button_get_relief (GtkButton *button)
{
* gtk_button_set_focus_on_click:
* @button: a #GtkButton
* @focus_on_click: whether the button grabs focus when clicked with the mouse
- *
+ *
* Sets whether the button will grab focus when it is clicked with the mouse.
* Making mouse clicks not grab focus is useful in places like toolbars where
* you don't want the keyboard focus removed from the main area of the
/**
* gtk_button_get_focus_on_click:
* @button: a #GtkButton
- *
+ *
* Returns whether the button grabs focus when it is clicked with the mouse.
* See gtk_button_set_focus_on_click().
*
* _gtk_button_set_depressed:
* @button: a #GtkButton
* @depressed: %TRUE if the button should be drawn with a recessed shadow.
- *
+ *
* Sets whether the button is currently drawn as down or not. This is
* purely a visual setting, and is meant only for use by derived widgets
* such as #GtkToggleButton.
projects / gtk4.git / commitdiff